GET v1/Discounts/{designId}/GetAllComps

Get All comps or get one or more comps within a specific designId

URI template

v1/Discounts/{designId}/GetAllComps?compIds[0]={compIds[0]}&compIds[1]={compIds[1]}

Request Information

URI Parameters

Name	Description	Type	Additional information
designId	DesignId	integer	Required
compIds	List of Comp Ids	Collection of integer	Required

Body Parameters

None.

Response Information

Resource Description

The comp object else returns null

Collection of Comp

Name	Description	Type	Additional information
SiteIds	Get Sites applied for this comp	Collection of integer	None.
Hours	Get the Hours property	Collection of CompHours	None.
DesignId	Get the DesignId property	integer	None.
CompId	Get the CompId property	integer	None.
Name	Get the Name property	string	None.
Description	Get the Description property	string	None.
PosCompId	Get the PosCompId property	integer	None.
CompCode	Get the CompCode property	string	None.
StartDate	Get the StartDate property	date	None.
EndDate	Get the EndDate property	date	None.
IsCustomerAccountRequired	Get the IsCustomerAccountRequired property	boolean	None.
IsEnabled	Get the IsEnabled property	boolean	None.
ReductionType	Get the ReductionType property	CompReductionType	None.
ReductionPercentOrAmount	Get the ReductionPercentOrAmount property	decimal number	None.
MaxReductionAmount	Get the MaxReductionAmount property	decimal number	None.
TransactionMinimum	Get the TransactionMinimum property	decimal number	None.
UsageControlType	Get the UsageControlType property	CompUsageControlType	None.
MaxUsageCountOrAmount	Get the MaxUsageCountOrAmount property	decimal number	None.
RecurringUsageCountOrAmount	Get the RecurringUsageCountOrAmount property	decimal number	None.
LastModifiedTimestamp	Get the LastModifiedTimestamp property	date	None.
SalesItemGroupId	Get the SalesItemGroupId property	integer	None.
FreeModifierCount	Get the FreeModifierCount property	integer	None.
LoyaltyId	Get the LoyaltyId property	integer	None.
AutoApply	Get the AutoApply property	boolean	None.
CustomerUsageTrackingRequired	UsageControlType == (int)CompUsageControlType.PerCustomerRecurringAmount \|\| UsageControlType == (int)CompUsageControlType.PerCustomerRecurringCount \|\| UsageControlType == (int)CompUsageControlType.PerCustomerUsageAmount \|\| UsageControlType == (int)CompUsageControlType.PerCustomerUsageCount;	boolean	None.
SiteGroups	Get the SiteGroups property	Collection of SiteGroup	None.
IncludedSite	Get the Included or Selected sites	Collection of SiteInSiteGroup	None.
ExcludedSite	Get the Excluded or Available sites	Collection of SiteInSiteGroup	None.
SupportedOrderModes	Get the Supported OrderModes	Collection of OrderModeType	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "SiteIds": [],
    "Hours": [
      {
        "$id": "2",
        "DayOfWeek": 0,
        "StartTime": "2025-04-24T13:45:00",
        "EndTime": "2025-04-24T13:45:00",
        "IsEnabled": true,
        "LastModifiedTimestamp": "2025-04-24T13:45:00"
      },
      {
        "$id": "3",
        "DayOfWeek": 0,
        "StartTime": "2025-04-24T13:45:00",
        "EndTime": "2025-04-24T13:45:00",
        "IsEnabled": true,
        "LastModifiedTimestamp": "2025-04-24T13:45:00"
      },
      {
        "$id": "4",
        "DayOfWeek": 0,
        "StartTime": "2025-04-24T13:45:00",
        "EndTime": "2025-04-24T13:45:00",
        "IsEnabled": true,
        "LastModifiedTimestamp": "2025-04-24T13:45:00"
      }
    ],
    "DesignId": 3,
    "CompId": 3,
    "Name": "100%off",
    "Description": null,
    "PosCompId": 100,
    "CompCode": "100off",
    "StartDate": "2025-04-24T13:45:00",
    "EndDate": "2025-04-24T13:45:00",
    "IsCustomerAccountRequired": false,
    "IsEnabled": true,
    "ReductionType": 1,
    "ReductionPercentOrAmount": 100.0,
    "MaxReductionAmount": 100.0,
    "TransactionMinimum": 1.0,
    "UsageControlType": 0,
    "MaxUsageCountOrAmount": null,
    "RecurringUsageCountOrAmount": null,
    "LastModifiedTimestamp": "2025-04-24T13:45:00",
    "SalesItemGroupId": null,
    "FreeModifierCount": 0,
    "LoyaltyId": null,
    "AutoApply": null,
    "CustomerUsageTrackingRequired": false,
    "SiteGroups": [
      {
        "$id": "5",
        "SiteGroupId": 1,
        "Name": "AOO Override Prices",
        "Description": "Items with a different price that those on the POS",
        "StoreIdentifier": 98167,
        "ExternalId": "99",
        "Sites": [
          {
            "$id": "6",
            "SiteId": 1,
            "SiteName": "FitNesse - Integrated",
            "ExternalId": "1",
            "StoreIdentifier": 136959
          },
          {
            "$id": "7",
            "SiteId": 2,
            "SiteName": "FitNesse - proxylab",
            "ExternalId": "1",
            "StoreIdentifier": 1000350
          }
        ],
        "LastModifiedTimestamp": "2025-04-24T13:45:00",
        "IsSingleMembershipType": false
      },
      {
        "$id": "8",
        "SiteGroupId": 2,
        "Name": "Price Overrides - Site Group",
        "Description": "Site Group for Price Overrides",
        "StoreIdentifier": 98167,
        "ExternalId": "99",
        "Sites": [],
        "LastModifiedTimestamp": "2025-04-24T13:45:00",
        "IsSingleMembershipType": true
      }
    ],
    "IncludedSite": [
      {
        "$id": "9",
        "SiteId": 61,
        "SiteName": "New Quick Combos",
        "SiteGroupIds": "",
        "SiteExternalId": "1",
        "SiteGroupNames": "",
        "SiteStoreIdentifier": 136959
      }
    ],
    "ExcludedSite": [
      {
        "$id": "10",
        "SiteId": 79,
        "SiteName": "Task Retail Site",
        "SiteGroupIds": "",
        "SiteExternalId": "79",
        "SiteGroupNames": "",
        "SiteStoreIdentifier": 112178
      }
    ],
    "SupportedOrderModes": []
  },
  {
    "$id": "11",
    "SiteIds": [],
    "Hours": [
      {
        "$id": "12",
        "DayOfWeek": 0,
        "StartTime": "2025-04-24T13:45:00",
        "EndTime": "2025-04-24T13:45:00",
        "IsEnabled": true,
        "LastModifiedTimestamp": "2025-04-24T13:45:00"
      },
      {
        "$id": "13",
        "DayOfWeek": 0,
        "StartTime": "2025-04-24T13:45:00",
        "EndTime": "2025-04-24T13:45:00",
        "IsEnabled": true,
        "LastModifiedTimestamp": "2025-04-24T13:45:00"
      },
      {
        "$id": "14",
        "DayOfWeek": 0,
        "StartTime": "2025-04-24T13:45:00",
        "EndTime": "2025-04-24T13:45:00",
        "IsEnabled": true,
        "LastModifiedTimestamp": "2025-04-24T13:45:00"
      }
    ],
    "DesignId": 3,
    "CompId": 2,
    "Name": "Flat 1 Dollar Off (For Automation Do Not Edit)",
    "Description": null,
    "PosCompId": 100,
    "CompCode": "1off",
    "StartDate": "2025-04-24T13:45:00",
    "EndDate": "2025-04-24T13:45:00",
    "IsCustomerAccountRequired": false,
    "IsEnabled": true,
    "ReductionType": 0,
    "ReductionPercentOrAmount": 1.0,
    "MaxReductionAmount": null,
    "TransactionMinimum": 1.5,
    "UsageControlType": 0,
    "MaxUsageCountOrAmount": null,
    "RecurringUsageCountOrAmount": null,
    "LastModifiedTimestamp": "2025-04-24T13:45:00",
    "SalesItemGroupId": null,
    "FreeModifierCount": 0,
    "LoyaltyId": null,
    "AutoApply": null,
    "CustomerUsageTrackingRequired": false,
    "SiteGroups": [
      {
        "$id": "15",
        "SiteGroupId": 1,
        "Name": "AOO Override Prices",
        "Description": "Items with a different price that those on the POS",
        "StoreIdentifier": 98167,
        "ExternalId": "99",
        "Sites": [],
        "LastModifiedTimestamp": "2025-04-24T13:45:00",
        "IsSingleMembershipType": false
      },
      {
        "$id": "16",
        "SiteGroupId": 2,
        "Name": "Price Overrides - Site Group",
        "Description": "Site Group for Price Overrides",
        "StoreIdentifier": 98167,
        "ExternalId": "99",
        "Sites": [],
        "LastModifiedTimestamp": "2025-04-24T13:45:00",
        "IsSingleMembershipType": true
      }
    ],
    "IncludedSite": [
      {
        "$id": "17",
        "SiteId": 61,
        "SiteName": "New Quick Combos",
        "SiteGroupIds": "",
        "SiteExternalId": "1",
        "SiteGroupNames": "",
        "SiteStoreIdentifier": 136959
      }
    ],
    "ExcludedSite": [
      {
        "$id": "18",
        "SiteId": 79,
        "SiteName": "Task Retail Site",
        "SiteGroupIds": "",
        "SiteExternalId": "79",
        "SiteGroupNames": "",
        "SiteStoreIdentifier": 112178
      }
    ],
    "SupportedOrderModes": []
  }
]

application/xml, text/xml

Sample:

<ArrayOfComp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <Comp>
    <AutoApply i:nil="true" />
    <CompCode>100off</CompCode>
    <CompId>3</CompId>
    <CustomerUsageTrackingRequired>false</CustomerUsageTrackingRequired>
    <Description i:nil="true" />
    <DesignId>3</DesignId>
    <EndDate>2025-04-24T13:45:00</EndDate>
    <ExcludedSite>
      <SiteInSiteGroup>
        <SiteExternalId>79</SiteExternalId>
        <SiteGroupIds></SiteGroupIds>
        <SiteGroupNames></SiteGroupNames>
        <SiteId>79</SiteId>
        <SiteName>Task Retail Site</SiteName>
        <SiteStoreIdentifier>112178</SiteStoreIdentifier>
      </SiteInSiteGroup>
    </ExcludedSite>
    <FreeModifierCount>0</FreeModifierCount>
    <Hours>
      <CompHours>
        <DayOfWeek>Sunday</DayOfWeek>
        <EndTime>2025-04-24T13:45:00</EndTime>
        <IsEnabled>true</IsEnabled>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <StartTime>2025-04-24T13:45:00</StartTime>
      </CompHours>
      <CompHours>
        <DayOfWeek>Sunday</DayOfWeek>
        <EndTime>2025-04-24T13:45:00</EndTime>
        <IsEnabled>true</IsEnabled>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <StartTime>2025-04-24T13:45:00</StartTime>
      </CompHours>
      <CompHours>
        <DayOfWeek>Sunday</DayOfWeek>
        <EndTime>2025-04-24T13:45:00</EndTime>
        <IsEnabled>true</IsEnabled>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <StartTime>2025-04-24T13:45:00</StartTime>
      </CompHours>
    </Hours>
    <IncludedSite>
      <SiteInSiteGroup>
        <SiteExternalId>1</SiteExternalId>
        <SiteGroupIds></SiteGroupIds>
        <SiteGroupNames></SiteGroupNames>
        <SiteId>61</SiteId>
        <SiteName>New Quick Combos</SiteName>
        <SiteStoreIdentifier>136959</SiteStoreIdentifier>
      </SiteInSiteGroup>
    </IncludedSite>
    <IsCustomerAccountRequired>false</IsCustomerAccountRequired>
    <IsEnabled>true</IsEnabled>
    <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
    <LoyaltyId i:nil="true" />
    <MaxReductionAmount>100</MaxReductionAmount>
    <MaxUsageCountOrAmount i:nil="true" />
    <Name>100%off</Name>
    <PosCompId>100</PosCompId>
    <RecurringUsageCountOrAmount i:nil="true" />
    <ReductionPercentOrAmount>100</ReductionPercentOrAmount>
    <ReductionType>Percentage</ReductionType>
    <SalesItemGroupId i:nil="true" />
    <SiteGroups>
      <SiteGroup>
        <Description>Items with a different price that those on the POS</Description>
        <ExternalId>99</ExternalId>
        <IsSingleMembershipType>false</IsSingleMembershipType>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <Name>AOO Override Prices</Name>
        <SiteGroupId>1</SiteGroupId>
        <Sites>
          <SiteBasicInfo />
          <SiteBasicInfo />
        </Sites>
        <StoreIdentifier>98167</StoreIdentifier>
      </SiteGroup>
      <SiteGroup>
        <Description>Site Group for Price Overrides</Description>
        <ExternalId>99</ExternalId>
        <IsSingleMembershipType>true</IsSingleMembershipType>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <Name>Price Overrides - Site Group</Name>
        <SiteGroupId>2</SiteGroupId>
        <Sites />
        <StoreIdentifier>98167</StoreIdentifier>
      </SiteGroup>
    </SiteGroups>
    <SiteIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <StartDate>2025-04-24T13:45:00</StartDate>
    <SupportedOrderModes xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Common.Models.v1" />
    <TransactionMinimum>1</TransactionMinimum>
    <UsageControlType>None</UsageControlType>
  </Comp>
  <Comp>
    <AutoApply i:nil="true" />
    <CompCode>1off</CompCode>
    <CompId>2</CompId>
    <CustomerUsageTrackingRequired>false</CustomerUsageTrackingRequired>
    <Description i:nil="true" />
    <DesignId>3</DesignId>
    <EndDate>2025-04-24T13:45:00</EndDate>
    <ExcludedSite>
      <SiteInSiteGroup>
        <SiteExternalId>79</SiteExternalId>
        <SiteGroupIds></SiteGroupIds>
        <SiteGroupNames></SiteGroupNames>
        <SiteId>79</SiteId>
        <SiteName>Task Retail Site</SiteName>
        <SiteStoreIdentifier>112178</SiteStoreIdentifier>
      </SiteInSiteGroup>
    </ExcludedSite>
    <FreeModifierCount>0</FreeModifierCount>
    <Hours>
      <CompHours>
        <DayOfWeek>Sunday</DayOfWeek>
        <EndTime>2025-04-24T13:45:00</EndTime>
        <IsEnabled>true</IsEnabled>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <StartTime>2025-04-24T13:45:00</StartTime>
      </CompHours>
      <CompHours>
        <DayOfWeek>Sunday</DayOfWeek>
        <EndTime>2025-04-24T13:45:00</EndTime>
        <IsEnabled>true</IsEnabled>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <StartTime>2025-04-24T13:45:00</StartTime>
      </CompHours>
      <CompHours>
        <DayOfWeek>Sunday</DayOfWeek>
        <EndTime>2025-04-24T13:45:00</EndTime>
        <IsEnabled>true</IsEnabled>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <StartTime>2025-04-24T13:45:00</StartTime>
      </CompHours>
    </Hours>
    <IncludedSite>
      <SiteInSiteGroup>
        <SiteExternalId>1</SiteExternalId>
        <SiteGroupIds></SiteGroupIds>
        <SiteGroupNames></SiteGroupNames>
        <SiteId>61</SiteId>
        <SiteName>New Quick Combos</SiteName>
        <SiteStoreIdentifier>136959</SiteStoreIdentifier>
      </SiteInSiteGroup>
    </IncludedSite>
    <IsCustomerAccountRequired>false</IsCustomerAccountRequired>
    <IsEnabled>true</IsEnabled>
    <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
    <LoyaltyId i:nil="true" />
    <MaxReductionAmount i:nil="true" />
    <MaxUsageCountOrAmount i:nil="true" />
    <Name>Flat 1 Dollar Off (For Automation Do Not Edit)</Name>
    <PosCompId>100</PosCompId>
    <RecurringUsageCountOrAmount i:nil="true" />
    <ReductionPercentOrAmount>1</ReductionPercentOrAmount>
    <ReductionType>FlatAmount</ReductionType>
    <SalesItemGroupId i:nil="true" />
    <SiteGroups>
      <SiteGroup>
        <Description>Items with a different price that those on the POS</Description>
        <ExternalId>99</ExternalId>
        <IsSingleMembershipType>false</IsSingleMembershipType>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <Name>AOO Override Prices</Name>
        <SiteGroupId>1</SiteGroupId>
        <Sites />
        <StoreIdentifier>98167</StoreIdentifier>
      </SiteGroup>
      <SiteGroup>
        <Description>Site Group for Price Overrides</Description>
        <ExternalId>99</ExternalId>
        <IsSingleMembershipType>true</IsSingleMembershipType>
        <LastModifiedTimestamp>2025-04-24T13:45:00</LastModifiedTimestamp>
        <Name>Price Overrides - Site Group</Name>
        <SiteGroupId>2</SiteGroupId>
        <Sites />
        <StoreIdentifier>98167</StoreIdentifier>
      </SiteGroup>
    </SiteGroups>
    <SiteIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <StartDate>2025-04-24T13:45:00</StartDate>
    <SupportedOrderModes xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Common.Models.v1" />
    <TransactionMinimum>1.5</TransactionMinimum>
    <UsageControlType>None</UsageControlType>
  </Comp>
</ArrayOfComp>